home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / clang / dtk_demo.zip / 5CONT.TXT < prev    next >
Text File  |  1991-09-12  |  15KB  |  588 lines
  1. Contents
  2.  
  3.  
  4. Chapter 1:     Installation and Use                              
  5.  
  6.      (a)  Contents of the library disk                             
  7.  
  8.      (b)  Installing the library and the header files                
  9.  
  10.      (c)  Using the library with Microsoft's CL compiler           
  11.  
  12.      (d)  Using the library with Borland's TCC compiler            
  13.  
  14.      (e)  Using more than one Dolphin library                      
  15.  
  16.  
  17. Chapter 2:     Conventions and Utilities                           
  18.  
  19.      (a)  The Dolphin defined types                                   
  20.  
  21.      (b)  The header files                                         
  22.  
  23.      (c)  The _f functions
  24.  
  25.      (d)  The SHOWFUNC utility                                    
  26.  
  27.  
  28. Chapter 3:     The Library Functions                              
  29.  
  30.      3.1       Date functions                                     
  31.  
  32.      Introduction                                                 
  33.  
  34.      date_earlier() & date_earlier_c()
  35.           Reports if one date is earlier than another.
  36.  
  37.      date_to_jdn() & date_to_jdn_c()
  38.           Converts a date to a Julian day number.
  39.  
  40.      date_to_str() & date_to_str_c()
  41.           Converts a date to a character string.
  42.  
  43.      date_valid() & date_valid_c()
  44.           Tells if a date is a valid date.
  45.  
  46.      day_name()
  47.           Returns "Sunday", etc.
  48.  
  49.      days_in_date_range() & days_in_date_range_c()
  50.           Returns days between two dates.
  51.  
  52.      days_in_month() & days_in_month_c()
  53.           Returns number of days in a given month.
  54.  
  55.      days_in_year() & days_in_year_c()
  56.           Returns number of days in a given year.
  57.  
  58.      day_of_week() & day_of_week_c()
  59.           Returns day-of-week for a given date.
  60.  
  61.      get_system_date()        
  62.           Fills in date structure with system date.
  63.  
  64.      is_leap_year() & is_leap_year_c()
  65.           Tells if a year is a leap year.
  66.  
  67.      is_weekday() & is_weekday_c()           
  68.           Tells if a date is a weekday.
  69.  
  70.      jdn_to_date() & jdn_to_date_c()
  71.           Converts a Julian day number to a date.
  72.  
  73.      month_length()           
  74.           Returns the usual length of a month.
  75.  
  76.      month_name()             
  77.           Returns "January", etc.
  78.  
  79.      rom_bios_date()          
  80.           Returns the ROM BIOS date.
  81.  
  82.      set_date_format_default()     
  83.           Sets up the default date format.
  84.  
  85.      set_system_date()        
  86.           Sets the system date.
  87.  
  88.      weekdays_in_date_range() & weekdays_in_date_range_c()
  89.           Returns number of weekdays in time period.
  90.  
  91.      weekdays_in_month() & weekdays_in_month_c()
  92.           Returns number of weekdays in given month.
  93.  
  94.      weekdays_in_year() & weekdays_in_year_c()
  95.           Returns number of weekdays in given year.
  96.  
  97.      yeartoa()                
  98.           Converts year to string with commas.
  99.  
  100.  
  101.      3.2       Time functions
  102.  
  103.      Introduction                             
  104.      
  105.      get_system_time()             
  106.           Gets the system time.
  107.  
  108.      set_system_time
  109.           Sets the system time.
  110.  
  111.      set_time_format_default()
  112.           Sets default time format values.
  113.  
  114.      time_elapsed()
  115.           Returns time elapsed.
  116.  
  117.      time_elapsed_this_decade()
  118.           Returns time elapsed this decade.
  119.  
  120.      time_to_str()
  121.           Converts a time to a string.
  122.  
  123.      time_valid()
  124.           Reports if a time is valid.
  125.  
  126.  
  127.      3.3       String functions                                   
  128.  
  129.      Introduction
  130.  
  131.      admissible_chars() & admissible_chars_f()
  132.           Ascertains whether a string consists only of
  133.           specified characters.
  134.  
  135.      atofp()
  136.           Converts a string to a far pointer.
  137.  
  138.      capitalize() & capitalize_f()
  139.           Capitalizes words in a string.
  140.  
  141.      char_at() & char_at_f()
  142.           Returns index in a string of a byte.
  143.  
  144.      common() & common_f()
  145.           Tells if two strings have a byte in common.
  146.  
  147.      double_char() & double_char_f()
  148.           Ascertains whether a double character occurs in a string.
  149.  
  150.      elim_chars() & elim_chars_f()
  151.           Eliminates characters from a string.
  152.  
  153.      elim_except() & elim_except_f()
  154.           Eliminates all characters from a string except
  155.           specified characters.
  156.  
  157.      elim_spaces() & elim_spaces_f()
  158.           Eliminates spaces from a string.
  159.  
  160.      final_char() & final_char_f()
  161.           Returns a pointer to the final byte of a string.
  162.  
  163.      final_null() & final_null_f()
  164.           Returns a pointer to the final null of a string.
  165.  
  166.      is_string_of() & is_string_of_f()
  167.           Ascertains if a string consists entirely of 
  168.           a specified character.
  169.  
  170.      lstrcpy() & lstrcpy_f()
  171.           Limited string copy.
  172.  
  173.      ltrim() & ltrim_f()
  174.           Left trims spaces from a string.
  175.  
  176.      ltrim_chr() & ltrim_chr_f()
  177.           Left trims bytes from a string.
  178.  
  179.      make_null() & make_null_f()
  180.           Makes a string into a null strng.
  181.  
  182.      num_occurrences() & num_occurrences_f()
  183.           Counts the number of occurrences of a byte in a string.
  184.  
  185.      ordinal_suffix()
  186.           Returns the ordinal suffix for a number.
  187.  
  188.      overlay_str() & overlay_str_f()
  189.           Overlays one string on another.
  190.  
  191.      overlay_str_n() & overlay_str_n_f()
  192.           Overlays a specified number of bytes from one string
  193.           on another.
  194.  
  195.      pad_on_left() & pad_on_left_f()
  196.           Pads a string on the left.
  197.  
  198.      pad_on_right() & pad_on_right_f()
  199.           Pads a string on the right.
  200.  
  201.      precedes() & precedes_f()
  202.           Ascertains if a specified character precedes another
  203.           in a string.
  204.  
  205.      replace_char() & replace_char_f()
  206.           Replaces a character in a string with another.
  207.  
  208.      replace_multiple_char() & replace_multiple_char_f()
  209.           Replaces multiple characters in a string with others.
  210.  
  211.      rtrim() & rtrim_f()
  212.           Right trims spaces from a string.
  213.  
  214.      rtrim_chr() & rtrim_chr_f()
  215.           Right trims bytes from a string.
  216.  
  217.      skip_chars() & skip_chars_f()
  218.           Skips specified characters in a string.
  219.  
  220.      sltoa_commas()
  221.           Converts a signed long to a string with commas.
  222.  
  223.      spaces() & spaces_f()
  224.           Makes a string of spaces.
  225.  
  226.      strcat_f()
  227.           Concatenates two far strings.
  228.  
  229.      strchr_f()
  230.           Returns a far pointer to a specified byte in a far string.
  231.  
  232.      strchr_n() & strchr_n_f()
  233.           Returns a pointer to the nth occurrence of a byte 
  234.           in a string.
  235.  
  236.      strcmp_f()
  237.           Compares two far strings.
  238.  
  239.      strcpy_f()
  240.           Copies a far string.
  241.  
  242.      string() & string_f()
  243.           Makes a string of specified bytes.
  244.  
  245.      strip_number() & strip_number_f()
  246.           Strips a number string of extraneous characters.
  247.  
  248.      strlen_f()
  249.           Returns the length of a far string.
  250.  
  251.      strlwr_f()
  252.           Converts a far string to lower case.
  253.  
  254.      strrchr_f()
  255.           Returns a pointer to the last occurrence of 
  256.           a specified character in a far string.
  257.  
  258.      strrchr_n() & strrchr_n_f()
  259.           Returns a pointer to the nth-last occurrence of 
  260.           a specified character in a string.
  261.  
  262.      strset_f()
  263.           Sets a far string to a byte value.
  264.  
  265.      strupr_f()
  266.           Converts a far string to upper case.
  267.  
  268.      str_trunc() & str_trunc_f()
  269.           Truncates a string to a given length.
  270.  
  271.      substr() & substr_f()
  272.           Copies a substring.
  273.  
  274.      substr_at() & substr_at_f()
  275.           Ascertains the position of a string in another string.
  276.  
  277.      trim() & trim_f()
  278.           Trims leading and trailing spaces.
  279.  
  280.      trim_chr() & trim_chr_f()
  281.           Trims leading and trailing bytes.
  282.  
  283.      tstrcpy() & tstrcpy_f()
  284.           Terminated string copy.
  285.  
  286.      ultoa_commas()
  287.           Converts an unsigned long to a string with commas.
  288.  
  289.  
  290.      3.4       Disk functions                          
  291.  
  292.      Introduction
  293.  
  294.      bios_disk_present()
  295.           Checks whether a disk is present in a given drive.
  296.  
  297.      bios_disk_read() & bios_disk_read_f()
  298.           Reads data from a disk.
  299.  
  300.      bios_disk_reset()
  301.           Resets the disk controller.
  302.  
  303.      bios_disk_status()
  304.           Returns disk operation status code.
  305.  
  306.      bios_disk_verify()
  307.           Verifies data on a disk.
  308.  
  309.      bios_disk_write() & bios_disk_write_f()
  310.           Writes data to a disk.
  311.  
  312.      disk_free_space()
  313.           Ascertains free space on a disk.
  314.  
  315.      disk_type()
  316.           Ascertains type of disk in a specified drive.
  317.  
  318.      drive_type()
  319.           Ascertains type of disk drive.
  320.  
  321.      get_disk_free()
  322.           Returns information about free space on a disk.
  323.  
  324.      get_drive()
  325.           Gets the current drive.
  326.  
  327.      get_drive_parameter_block()
  328.           Reads the drive parameter block data for a given drive.
  329.  
  330.      high_drive()
  331.           Returns highest valid drive letter.
  332.  
  333.      last_drive_used()
  334.           Checks whether first floppy drive last accessed 
  335.           as A: or as B:
  336.  
  337.      num_floppy_drives()
  338.           Number of floppy disk drives.
  339.  
  340.      num_hard_drives()
  341.           Number of hard disk drives.
  342.  
  343.      set_drive()
  344.           Sets the current drive.
  345.  
  346.      valid_drive()
  347.           Checks if a drive letter is valid.
  348.  
  349.  
  350.      3.5       Directory functions
  351.  
  352.      Introduction
  353.  
  354.      create_path()
  355.           Creates a subdirectory path.
  356.  
  357.      create_subdirectory() & create_subdirectory_f()
  358.           Creates a subdirectory.
  359.  
  360.      file_path() & file_path_f()
  361.           Gets info on path and file.
  362.  
  363.      get_directory() & get_directory_f()
  364.           Gets the current directory.
  365.  
  366.      make_path() & make_path_f()
  367.           Composes a path.
  368.  
  369.      normalize_path() & normalize_path_f()
  370.           Converts path to normal form.
  371.  
  372.      same_path() & same_path_f()
  373.           Ascertains if two paths are the same.
  374.  
  375.      set_directory() & set_directory_f()
  376.           Sets the current directory.
  377.  
  378.      split_path() & split_path_f()
  379.           Decomposes a path.
  380.  
  381.  
  382.      3.6       File functions                          
  383.  
  384.      Introduction
  385.  
  386.      atod_array() & atod_array_f()
  387.           Reads double precision floating point values from 
  388.           a file into an array.
  389.  
  390.      atoi_array() & atoi_array_f()
  391.           Reads integer values from a file into an array.
  392.  
  393.      construct_output_filenames() & construct_output_filenames_f()
  394.           Converts a list of file names to another list 
  395.           of file names in accordance with file name patterns.
  396.  
  397.      delete_files() & delete_files_f()
  398.           Deletes files satisfying a file path specification
  399.           and an attribute specification.
  400.  
  401.      file_exists() & file_exists_f()
  402.           Ascertains if a file exists.
  403.  
  404.      file_size() & file_size_f()
  405.           Gets a file's size.
  406.  
  407.      file_type()
  408.           Gets a file's type.
  409.  
  410.      get_fh_date_time()
  411.           Gets the date and time stamps for a file opened with 
  412.           a particular file handle.
  413.  
  414.      get_file_date_time()
  415.           Gets the date and time stamps for a file.
  416.  
  417.      get_input_output_files()
  418.           Parses the command line and constructs a list of 
  419.           input files and a list of output files.
  420.  
  421.      make_file_name()
  422.           Makes a file name conforming to a pattern.
  423.  
  424.      make_new_file_name()
  425.           Makes a file name, not already in use, conforming to 
  426.           a pattern.
  427.  
  428.      num_lines_in_file()
  429.           Counts the number of lines in a text file.
  430.  
  431.      num_matching_files()
  432.           Gets the number of files matching a given file and
  433.           attribute specification.
  434.  
  435.      open_new_buffered_file()
  436.           Opens a new file for buffered I/O.
  437.  
  438.      open_new_unbuffered_file()
  439.           Opens a new file for unbuffered I/O.
  440.  
  441.      overwrite_file()
  442.           Overwrites a file.
  443.  
  444.      read_directory() & read_directory_f()
  445.           Reads the contents of a subdirectory into an array.
  446.  
  447.      read_f()
  448.           Reads from a file into a far memory buffer.
  449.  
  450.      save_values_in_exe()
  451.           Saves values in an .EXE file.
  452.  
  453.      set_fh_date_time()
  454.           Sets the date and time stamps for a file opened with 
  455.           a particular file handle.
  456.  
  457.      set_file_date_time() & set_file_date_time_f()
  458.           Sets the date and time stamps for a file.
  459.  
  460.      write_f()
  461.           Writes to a file from a far memory buffer.
  462.  
  463.  
  464.      3.7       Print spooler functions
  465.  
  466.      Introduction
  467.  
  468.      print_spool_cancel_all()
  469.           Cancels all files in the print queue.
  470.  
  471.      print_spool_cancel_file() & print_spool_cancel_file_f()
  472.           Cancels a file in the print queue.
  473.  
  474.      print_spool_end_hold()
  475.           Ends a hold on the spooler.
  476.  
  477.      print_spool_hold()
  478.           Suspends the print spooler.
  479.  
  480.      print_spool_install()
  481.           Installs the print spooler.
  482.  
  483.      print_spool_status()
  484.           Reports on status of the print spooler.
  485.  
  486.      print_spool_submit_file() & print_spool_submit_file_f()
  487.           Submits a file to the print spooler.
  488.  
  489.      
  490.      3.8       Other printer functions                 
  491.  
  492.      Introduction
  493.  
  494.      eject_page()
  495.           Ejects a page.
  496.  
  497.      num_printers()
  498.           Returns the number of printers installed.
  499.  
  500.      printer_init()
  501.           Initializes a parallel printer.
  502.  
  503.      printer_ready()
  504.           Tests if a parallel printer is ready.
  505.  
  506.      print_char()
  507.           Sends a byte to a parallel printer.
  508.  
  509.      print_file()
  510.           Prints a text file with some formatting.
  511.  
  512.      print_screen()
  513.           Dumps the screen to the printer.
  514.  
  515.  
  516.      3.9      Other functions
  517.  
  518.      Introduction
  519.  
  520.      dos_version()
  521.           Reports DOS version.
  522.  
  523.      gets_n()
  524.           Gets a limited string from the keyboard.
  525.  
  526.      input_redirected()
  527.           Detects redirection of input.
  528.  
  529.      math_coprocessor()
  530.           Reports presence of a math coprocessor.
  531.  
  532.      output_redirected()
  533.           Detects redirection of output.
  534.  
  535.      reboot()
  536.           Causes system reboot.
  537.  
  538.      swap() & swap_f()
  539.           Swaps values of two variables.
  540.  
  541.      toolkit_version_number()
  542.           Reports the library version number.
  543.  
  544.           
  545. Chapter 4:     The Demonstration Programs                        
  546.  
  547.     (a)  CALCONV
  548.     (b)  DATEFORM
  549.     (c)  NWEEKDAY
  550.     (d)  TIMEFORM
  551.     (e)  DSKPARAM
  552.     (f)  CURRDIR
  553.     (g)  SPLIT_P
  554.     (h)  DIR_ATTR
  555.     (i)  SETFDATE
  556.     (j)  COMPARE
  557.     (k)  NUMLINES
  558.     (l)  PR_SPOOL
  559.     (m)  ALL_DRVS
  560.     (n)  FINAL
  561.     (o)  TIMER
  562.     (p)  DISKTYPE
  563.     (q)  MAKE&DEL
  564.     (r)  SAVEVALS
  565.     (s)  FILETYPE
  566.     (t)  MCDEMO
  567.  
  568.  
  569. Appendix I:    Memory Models
  570.  
  571. Appendix II:   The Julian and the Gregorian Calendars
  572.  
  573. Appendix III:  Listings of the Header Files                    
  574.  
  575.      (a)  L_TYPEDF.H
  576.      (b)  L_AUXSTR.H
  577.      (c)  L_DATE.H
  578.      (d)  L_TIME.H
  579.      (e)  L_STR.H
  580.      (f)  L_DISK.H  
  581.      (g)  L_DIR.H
  582.      (h)  L_FILE.H
  583.      (i)  L_PRINT.H
  584.      (j)  L_MISC.H
  585.  
  586. Appendix IV:   Index of Functions
  587.  
  588.